<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: snmp_node_instance Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">lwIP
   &#160;<span id="projectnumber">2.1.2</span>
   </div>
   <div id="projectbrief">Lightweight IP stack</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structsnmp__node__instance.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">snmp_node_instance Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;snmp_core.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4136f44404b25f4d4dacc6b6b76e77ac"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structsnmp__node.html">snmp_node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a4136f44404b25f4d4dacc6b6b76e77ac">node</a></td></tr>
<tr class="separator:a4136f44404b25f4d4dacc6b6b76e77ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedb358729c310c8e5b391dd256726a23"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structsnmp__obj__id.html">snmp_obj_id</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#aedb358729c310c8e5b391dd256726a23">instance_oid</a></td></tr>
<tr class="separator:aedb358729c310c8e5b391dd256726a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af51206e0912a8402c395dcf3b623f8b9"><td class="memItemLeft" align="right" valign="top">u8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#af51206e0912a8402c395dcf3b623f8b9">asn1_type</a></td></tr>
<tr class="separator:af51206e0912a8402c395dcf3b623f8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4af17d17a971f1d11a186e6e1fc4411c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="snmp__core_8h.html#ad5a33687d1a6fcf970266b41b0633760">snmp_access_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a4af17d17a971f1d11a186e6e1fc4411c">access</a></td></tr>
<tr class="separator:a4af17d17a971f1d11a186e6e1fc4411c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17aa954aa34672f4a399bf0d91c0a649"><td class="memItemLeft" align="right" valign="top">node_instance_get_value_method&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a17aa954aa34672f4a399bf0d91c0a649">get_value</a></td></tr>
<tr class="separator:a17aa954aa34672f4a399bf0d91c0a649"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c1fec3764f6b48337238b3355ee5bd"><td class="memItemLeft" align="right" valign="top">node_instance_set_test_method&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a03c1fec3764f6b48337238b3355ee5bd">set_test</a></td></tr>
<tr class="separator:a03c1fec3764f6b48337238b3355ee5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55fb4cadefcab9c74c3fb529c2560834"><td class="memItemLeft" align="right" valign="top">node_instance_set_value_method&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a55fb4cadefcab9c74c3fb529c2560834">set_value</a></td></tr>
<tr class="separator:a55fb4cadefcab9c74c3fb529c2560834"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20a256c54fab19a455ecf6deff76c6de"><td class="memItemLeft" align="right" valign="top">node_instance_release_method&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a20a256c54fab19a455ecf6deff76c6de">release_instance</a></td></tr>
<tr class="separator:a20a256c54fab19a455ecf6deff76c6de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55f53419cd5b369b771153ca2598ebc5"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionsnmp__variant__value.html">snmp_variant_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#a55f53419cd5b369b771153ca2598ebc5">reference</a></td></tr>
<tr class="separator:a55f53419cd5b369b771153ca2598ebc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad289957b34b4e55915fa79f37c4d9d54"><td class="memItemLeft" align="right" valign="top">u32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnmp__node__instance.html#ad289957b34b4e55915fa79f37c4d9d54">reference_len</a></td></tr>
<tr class="separator:ad289957b34b4e55915fa79f37c4d9d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SNMP node instance </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a4af17d17a971f1d11a186e6e1fc4411c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4af17d17a971f1d11a186e6e1fc4411c">&#9670;&nbsp;</a></span>access</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="snmp__core_8h.html#ad5a33687d1a6fcf970266b41b0633760">snmp_access_t</a> snmp_node_instance::access</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>one out of instance access types defined above (SNMP_NODE_INSTANCE_READ_ONLY,...) </p>

</div>
</div>
<a id="af51206e0912a8402c395dcf3b623f8b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af51206e0912a8402c395dcf3b623f8b9">&#9670;&nbsp;</a></span>asn1_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8_t snmp_node_instance::asn1_type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>ASN type for this object (see <a class="el" href="snmp__asn1_8h.html">snmp_asn1.h</a> for definitions) </p>

</div>
</div>
<a id="a17aa954aa34672f4a399bf0d91c0a649"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17aa954aa34672f4a399bf0d91c0a649">&#9670;&nbsp;</a></span>get_value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">node_instance_get_value_method snmp_node_instance::get_value</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>returns object value for the given object identifier. Return values &lt;0 to indicate an error </p>

</div>
</div>
<a id="aedb358729c310c8e5b391dd256726a23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedb358729c310c8e5b391dd256726a23">&#9670;&nbsp;</a></span>instance_oid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structsnmp__obj__id.html">snmp_obj_id</a> snmp_node_instance::instance_oid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>prefilled with the instance id requested; for get_instance() this is the exact oid requested; for get_next_instance() this is the relative starting point, stack expects relative oid of next node here </p>

</div>
</div>
<a id="a4136f44404b25f4d4dacc6b6b76e77ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4136f44404b25f4d4dacc6b6b76e77ac">&#9670;&nbsp;</a></span>node</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const struct <a class="el" href="structsnmp__node.html">snmp_node</a>* snmp_node_instance::node</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>prefilled with the node, get_instance() is called on; may be changed by user to any value to pass an arbitrary node between calls to get_instance() and get_value/test_value/set_value </p>

</div>
</div>
<a id="a55f53419cd5b369b771153ca2598ebc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55f53419cd5b369b771153ca2598ebc5">&#9670;&nbsp;</a></span>reference</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union <a class="el" href="unionsnmp__variant__value.html">snmp_variant_value</a> snmp_node_instance::reference</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>reference to pass arbitrary value between calls to get_instance() and get_value/test_value/set_value </p>

</div>
</div>
<a id="ad289957b34b4e55915fa79f37c4d9d54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad289957b34b4e55915fa79f37c4d9d54">&#9670;&nbsp;</a></span>reference_len</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32_t snmp_node_instance::reference_len</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>see reference (if reference is a pointer, the length of underlying data may be stored here or anything else) </p>

</div>
</div>
<a id="a20a256c54fab19a455ecf6deff76c6de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20a256c54fab19a455ecf6deff76c6de">&#9670;&nbsp;</a></span>release_instance</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">node_instance_release_method snmp_node_instance::release_instance</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called in any case when the instance is not required anymore by stack (useful for freeing memory allocated in get_instance/get_next_instance methods) </p>

</div>
</div>
<a id="a03c1fec3764f6b48337238b3355ee5bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c1fec3764f6b48337238b3355ee5bd">&#9670;&nbsp;</a></span>set_test</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">node_instance_set_test_method snmp_node_instance::set_test</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>tests length and/or range BEFORE setting </p>

</div>
</div>
<a id="a55fb4cadefcab9c74c3fb529c2560834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55fb4cadefcab9c74c3fb529c2560834">&#9670;&nbsp;</a></span>set_value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">node_instance_set_value_method snmp_node_instance::set_value</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>sets object value, only called when <a class="el" href="structsnmp__node__instance.html#a03c1fec3764f6b48337238b3355ee5bd">set_test()</a> was successful </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/lwip/apps/<a class="el" href="snmp__core_8h.html">snmp_core.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structsnmp__node__instance.html">snmp_node_instance</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
